home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1998 April: Mac OS SDK / Dev.CD Apr 98 SDK1.toast / Development Kits (Disc 1) / Interfaces&Libraries / Universal / Interfaces / AIncludes / Folders.a < prev    next >
Encoding:
Text File  |  1998-02-12  |  12.0 KB  |  354 lines  |  [TEXT/MPS ]
  1. ;
  2. ;    File:        Folders.a
  3. ;
  4. ;    Contains:    Folder Manager Interfaces.
  5. ;
  6. ;    Version:    Technology:    Mac OS 8
  7. ;                Release:    Universal Interfaces 3.1
  8. ;
  9. ;    Copyright:    © 1995-1998 by Apple Computer, Inc., all rights reserved.
  10. ;
  11. ;    Bugs?:        Please include the the file and version information (from above) with
  12. ;                the problem description.  Developers belonging to one of the Apple
  13. ;                developer programs can submit bug reports to:
  14. ;
  15. ;                    devsupport@apple.com
  16. ;
  17. ;
  18.     IF &TYPE('__FOLDERS__') = 'UNDEFINED' THEN
  19. __FOLDERS__ SET 1
  20.  
  21.     IF &TYPE('__MACTYPES__') = 'UNDEFINED' THEN
  22.     include 'MacTypes.a'
  23.     ENDIF
  24.  
  25.  
  26. kOnSystemDisk                    EQU        -32768                ; previously was 0x8000 but that is an unsigned value whereas vRefNum is signed
  27.  
  28. kCreateFolder                    EQU        1
  29. kDontCreateFolder                EQU        0
  30.  
  31. kSystemFolderType                EQU        'macs'                ; the system folder 
  32. kDesktopFolderType                EQU        'desk'                ; the desktop folder; objects in this folder show on the desk top. 
  33. kTrashFolderType                EQU        'trsh'                ; the trash folder; objects in this folder show up in the trash 
  34. kWhereToEmptyTrashFolderType    EQU        'empt'                ; the "empty trash" folder; Finder starts empty from here down 
  35. kPrintMonitorDocsFolderType        EQU        'prnt'                ; Print Monitor documents 
  36. kStartupFolderType                EQU        'strt'                ; Finder objects (applications, documents, DAs, aliases, to...) to open at startup go here 
  37. kShutdownFolderType                EQU        'shdf'                ; Finder objects (applications, documents, DAs, aliases, to...) to open at shutdown go here 
  38. kAppleMenuFolderType            EQU        'amnu'                ; Finder objects to put into the Apple menu go here 
  39. kControlPanelFolderType            EQU        'ctrl'                ; Control Panels go here (may contain INITs) 
  40. kExtensionFolderType            EQU        'extn'                ; System extensions go here 
  41. kFontsFolderType                EQU        'font'                ; Fonts go here 
  42. kPreferencesFolderType            EQU        'pref'                ; preferences for applications go here 
  43. kTemporaryFolderType            EQU        'temp'                ; temporary files go here (deleted periodically, but don't rely on it.) 
  44. ; 
  45. ;    Note:     The FindFolder trap was not implemented until System 7.  If you want to call FindFolder
  46. ;            while running on System 6 machines, then define USE_FINDFOLDER_GLUE and link with
  47. ;            Interface.o which contains glue to implement FindFolder on pre-System 7 machines.
  48. ;
  49.  
  50.     IF &TYPE('USE_FINDFOLDER_GLUE') <> 'UNDEFINED' THEN
  51. ;
  52. ; pascal OSErr FindFolder(short vRefNum, OSType folderType, Boolean createFolder, short *foundVRefNum, long *foundDirID)
  53. ;
  54.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  55.         IMPORT_CFM_FUNCTION FindFolder
  56.     ENDIF
  57.  
  58.     ELSE
  59. ;
  60. ; pascal OSErr FindFolder(short vRefNum, OSType folderType, Boolean createFolder, short *foundVRefNum, long *foundDirID)
  61. ;
  62.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  63.         Macro
  64.         _FindFolder
  65.             moveq               #0,D0
  66.             dc.w                $A823
  67.         EndM
  68.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  69.         IMPORT_CFM_FUNCTION FindFolder
  70.     ENDIF
  71.  
  72.     ENDIF
  73. ;
  74. ; pascal OSErr ReleaseFolder(short vRefNum, OSType folderType)
  75. ;
  76.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  77.         Macro
  78.         _ReleaseFolder
  79.             moveq               #11,D0
  80.             dc.w                $A823
  81.         EndM
  82.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  83.         IMPORT_CFM_FUNCTION ReleaseFolder
  84.     ENDIF
  85.  
  86.  
  87.     IF ¬ TARGET_OS_MAC THEN
  88. ;  Since non-mac targets don't know about VRef's or DirID's, the Ex version returns
  89. ;   the found folder path.
  90. ; 
  91.  
  92. ;
  93. ; extern OSErr FindFolderEx(short vRefNum, OSType folderType, Boolean createFolder, short *foundVRefNum, long *foundDirID, char *foundFolder)
  94. ;
  95.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  96.         IMPORT_CFM_FUNCTION FindFolderEx
  97.     ENDIF
  98.  
  99.     ENDIF
  100. ; *****************************************
  101. ;  Extensible Folder Manager declarations 
  102. ; *****************************************
  103.  
  104. ; ***************************
  105. ;  Folder Manager constants 
  106. ; ***************************
  107.  
  108.  
  109. kExtensionDisabledFolderType    EQU        'extD'
  110. kControlPanelDisabledFolderType    EQU        'ctrD'
  111. kSystemExtensionDisabledFolderType EQU    'macD'
  112. kStartupItemsDisabledFolderType    EQU        'strD'
  113. kShutdownItemsDisabledFolderType EQU    'shdD'
  114. kApplicationsFolderType            EQU        'apps'
  115. kDocumentsFolderType            EQU        'docs'
  116.  
  117.                                                             ; new constants 
  118. kVolumeRootFolderType            EQU        'root'                ; root folder of a volume 
  119. kChewableItemsFolderType        EQU        'flnt'                ; items deleted at boot 
  120. kApplicationSupportFolderType    EQU        'asup'                ; third-party items and folders 
  121. kTextEncodingsFolderType        EQU        'ƒtex'                ; encoding tables 
  122. kStationeryFolderType            EQU        'odst'                ; stationery 
  123. kOpenDocFolderType                EQU        'odod'                ; OpenDoc root 
  124. kOpenDocShellPlugInsFolderType    EQU        'odsp'                ; OpenDoc Shell Plug-Ins in OpenDoc folder 
  125. kEditorsFolderType                EQU        'oded'                ; OpenDoc editors in MacOS Folder 
  126. kOpenDocEditorsFolderType        EQU        'ƒodf'                ; OpenDoc subfolder of Editors folder 
  127. kOpenDocLibrariesFolderType        EQU        'odlb'                ; OpenDoc libraries folder 
  128. kGenEditorsFolderType            EQU        'ƒedi'                ; CKH general editors folder at root level of Sys folder 
  129. kHelpFolderType                    EQU        'ƒhlp'                ; CKH help folder currently at root of system folder 
  130. kInternetPlugInFolderType        EQU        'ƒnet'                ; CKH internet plug ins for browsers and stuff 
  131. kModemScriptsFolderType            EQU        'ƒmod'                ; CKH modem scripts, get 'em OUT of the Extensions folder 
  132. kPrinterDescriptionFolderType    EQU        'ppdf'                ; CKH new folder at root of System folder for printer descs. 
  133. kPrinterDriverFolderType        EQU        'ƒprd'                ; CKH new folder at root of System folder for printer drivers 
  134. kScriptingAdditionsFolderType    EQU        'ƒscr'                ; CKH at root of system folder 
  135. kSharedLibrariesFolderType        EQU        'ƒlib'                ; CKH for general shared libs. 
  136. kVoicesFolderType                EQU        'fvoc'                ; CKH macintalk can live here 
  137. kControlStripModulesFolderType    EQU        'sdev'                ; CKH for control strip modules 
  138. kAssistantsFolderType            EQU        'astƒ'                ; SJF for Assistants (MacOS Setup Assistant, etc) 
  139. kUtilitiesFolderType            EQU        'utiƒ'                ; SJF for Utilities folder 
  140. kAppleExtrasFolderType            EQU        'aexƒ'                ; SJF for Apple Extras folder 
  141. kContextualMenuItemsFolderType    EQU        'cmnu'                ; SJF for Contextual Menu items 
  142. kMacOSReadMesFolderType            EQU        'morƒ'                ; SJF for MacOS ReadMes folder 
  143. kALMModulesFolderType            EQU        'walk'                ; EAS for Location Manager Module files except type 'thng' (within kExtensionFolderType) 
  144. kALMPreferencesFolderType        EQU        'trip'                ; EAS for Location Manager Preferences (within kPreferencesFolderType; contains kALMLocationsFolderType) 
  145. kALMLocationsFolderType            EQU        'fall'                ; EAS for Location Manager Locations (within kALMPreferencesFolderType) 
  146. kColorSyncProfilesFolderType    EQU        'prof'                ; for ColorSync™ Profiles 
  147. kThemesFolderType                EQU        'thme'                ; for Theme data files 
  148. kFavoritesFolderType            EQU        'favs'                ; Favorties folder for Navigation Services 
  149.  
  150. ;  FolderDescFlags values 
  151.  
  152. kCreateFolderAtBoot                EQU        $00000002
  153. kFolderCreatedInvisible            EQU        $00000004
  154. kFolderCreatedNameLocked        EQU        $00000008
  155. ; typedef UInt32                         FolderDescFlags
  156.  
  157. ;  FolderClass values 
  158.  
  159. kRelativeFolder                    EQU        'relf'
  160. kSpecialFolder                    EQU        'spcf'
  161. ; typedef OSType                         FolderClass
  162.  
  163. ;  special folder locations 
  164.  
  165. kBlessedFolder                    EQU        'blsf'
  166. kRootFolder                        EQU        'rotf'
  167. ; typedef OSType                         FolderType
  168.  
  169. ; typedef OSType                         FolderLocation
  170.  
  171.  
  172. FolderDesc                RECORD 0
  173. descSize                 ds.l    1                ; offset: $0 (0)
  174. foldType                 ds.l    1                ; offset: $4 (4)
  175. flags                     ds.l    1                ; offset: $8 (8)
  176. foldClass                 ds.l    1                ; offset: $C (12)
  177. foldLocation             ds.l    1                ; offset: $10 (16)
  178. badgeSignature             ds.l    1                ; offset: $14 (20)
  179. badgeType                 ds.l    1                ; offset: $18 (24)
  180. reserved                 ds.l    1                ; offset: $1C (28)
  181. name                     ds        StrFileName        ; offset: $20 (32)        ;  Str63 on MacOS
  182. sizeof                     EQU *                    ; size:   $60 (96)
  183.                         ENDR
  184. ; typedef struct FolderDesc *            FolderDescPtr
  185.  
  186.  
  187. ; typedef UInt32                         RoutingFlags
  188.  
  189. FolderRouting            RECORD 0
  190. descSize                 ds.l    1                ; offset: $0 (0)
  191. fileType                 ds.l    1                ; offset: $4 (4)
  192. routeFromFolder             ds.l    1                ; offset: $8 (8)
  193. routeToFolder             ds.l    1                ; offset: $C (12)
  194. flags                     ds.l    1                ; offset: $10 (16)
  195. sizeof                     EQU *                    ; size:   $14 (20)
  196.                         ENDR
  197. ; typedef struct FolderRouting *        FolderRoutingPtr
  198.  
  199. ;  routing constants 
  200. ; **************************
  201. ;  Folder Manager routines 
  202. ; **************************
  203. ;  Folder Manager administration routines 
  204. ;
  205. ; pascal OSErr AddFolderDescriptor(FolderType foldType, FolderDescFlags flags, FolderClass foldClass, FolderLocation foldLocation, OSType badgeSignature, OSType badgeType, ConstStrFileNameParam name, Boolean replaceFlag)
  206. ;
  207.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  208.         Macro
  209.         _AddFolderDescriptor
  210.             moveq               #32,D0
  211.             dc.w                $A823
  212.         EndM
  213.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  214.         IMPORT_CFM_FUNCTION AddFolderDescriptor
  215.     ENDIF
  216.  
  217. ;
  218. ; pascal OSErr GetFolderDescriptor(FolderType foldType, Size descSize, FolderDesc *foldDesc)
  219. ;
  220.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  221.         Macro
  222.         _GetFolderDescriptor
  223.             moveq               #35,D0
  224.             dc.w                $A823
  225.         EndM
  226.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  227.         IMPORT_CFM_FUNCTION GetFolderDescriptor
  228.     ENDIF
  229.  
  230. ;
  231. ; pascal OSErr GetFolderTypes(UInt32 requestedTypeCount, UInt32 *totalTypeCount, FolderType *theTypes)
  232. ;
  233.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  234.         Macro
  235.         _GetFolderTypes
  236.             moveq               #36,D0
  237.             dc.w                $A823
  238.         EndM
  239.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  240.         IMPORT_CFM_FUNCTION GetFolderTypes
  241.     ENDIF
  242.  
  243. ;
  244. ; pascal OSErr RemoveFolderDescriptor(FolderType foldType)
  245. ;
  246.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  247.         Macro
  248.         _RemoveFolderDescriptor
  249.             moveq               #33,D0
  250.             dc.w                $A823
  251.         EndM
  252.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  253.         IMPORT_CFM_FUNCTION RemoveFolderDescriptor
  254.     ENDIF
  255.  
  256. ;  legacy routines 
  257. ;
  258. ; pascal OSErr GetFolderName(short vRefNum, OSType foldType, short *foundVRefNum, StrFileName name)
  259. ;
  260.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  261.         Macro
  262.         _GetFolderName
  263.             moveq               #14,D0
  264.             dc.w                $A823
  265.         EndM
  266.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  267.         IMPORT_CFM_FUNCTION GetFolderName
  268.     ENDIF
  269.  
  270. ;  routing routines 
  271. ;
  272. ; pascal OSErr AddFolderRouting(OSType fileType, FolderType routeFromFolder, FolderType routeToFolder, RoutingFlags flags, Boolean replaceFlag)
  273. ;
  274.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  275.         Macro
  276.         _AddFolderRouting
  277.             moveq               #38,D0
  278.             dc.w                $A823
  279.         EndM
  280.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  281.         IMPORT_CFM_FUNCTION AddFolderRouting
  282.     ENDIF
  283.  
  284. ;
  285. ; pascal OSErr RemoveFolderRouting(OSType fileType, FolderType routeFromFolder)
  286. ;
  287.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  288.         Macro
  289.         _RemoveFolderRouting
  290.             moveq               #39,D0
  291.             dc.w                $A823
  292.         EndM
  293.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  294.         IMPORT_CFM_FUNCTION RemoveFolderRouting
  295.     ENDIF
  296.  
  297. ;
  298. ; pascal OSErr FindFolderRouting(OSType fileType, FolderType routeFromFolder, FolderType *routeToFolder, RoutingFlags *flags)
  299. ;
  300.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  301.         Macro
  302.         _FindFolderRouting
  303.             moveq               #34,D0
  304.             dc.w                $A823
  305.         EndM
  306.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  307.         IMPORT_CFM_FUNCTION FindFolderRouting
  308.     ENDIF
  309.  
  310. ;
  311. ; pascal OSErr GetFolderRoutings(UInt32 requestedRoutingCount, UInt32 *totalRoutingCount, Size routingSize, FolderRouting *theRoutings)
  312. ;
  313.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  314.         Macro
  315.         _GetFolderRoutings
  316.             moveq               #30,D0
  317.             dc.w                $A823
  318.         EndM
  319.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  320.         IMPORT_CFM_FUNCTION GetFolderRoutings
  321.     ENDIF
  322.  
  323. ;
  324. ; pascal OSErr InvalidateFolderDescriptorCache(short vRefNum, long dirID)
  325. ;
  326.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  327.         Macro
  328.         _InvalidateFolderDescriptorCache
  329.             moveq               #37,D0
  330.             dc.w                $A823
  331.         EndM
  332.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  333.         IMPORT_CFM_FUNCTION InvalidateFolderDescriptorCache
  334.     ENDIF
  335.  
  336. ;
  337. ; pascal OSErr IdentifyFolder(short vRefNum, long dirID, FolderType *foldType)
  338. ;
  339.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  340.         Macro
  341.         _IdentifyFolder
  342.             moveq               #31,D0
  343.             dc.w                $A823
  344.         EndM
  345.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  346.         IMPORT_CFM_FUNCTION IdentifyFolder
  347.     ENDIF
  348.  
  349.  
  350.  
  351.  
  352.     ENDIF ; __FOLDERS__ 
  353.  
  354.